home *** CD-ROM | disk | FTP | other *** search
/ Belgian Amiga Club - ADF Collection / BS1 part 27.zip / BS1 part 27 / Condo.V2.04_d2.adf / HelpFiles / Screen and Window  < prev    next >
Text File  |  1993-03-08  |  9KB  |  506 lines
  1. C- GetViewOffset        |getviewoffset|
  2. C- GetWindowLimits        |getwindowlimits|
  3. V- HiRes                |hires|
  4. V- Interlace            |interlace|
  5. V- MouseX                |mousex|
  6. V- MouseY                |mousey|
  7. C- MoveScreen            |movescreen|
  8. C- MoveWindow            |movewindow|
  9. V- NTSC                    |ntsc|
  10. C- Pointer                |pointer|
  11. C- ResizeWindow            |resizewindow|
  12. V- ScreenAddress        |screenaddress|
  13. V- ScreenColors            |screencolors|
  14. V- ScreenHeight            |screenheight|
  15. V- ScreenTitle            |screentitle|
  16. C- ScreenTitleBar        |screentitlebar|
  17. C- ScreenTo                |screento|
  18. V- ScreenWidth            |screenwidth|
  19. V- ScreenX                |screenx|
  20. V- ScreenY                |screeny|
  21. C- SetPointer            |setpointer|
  22. C- SetScreenTitle        |setscreentitle|
  23. C- SetViewOffset        |setviewoffset|
  24. C- SetWindowLimits        |setwindowlimits|
  25. C- SetWindowTitle        |setwindowtitle|
  26. V- WindowAddress        |windowaddress|
  27. V- WindowBorderBottom    |windowborderbottom|
  28. V- WindowBorderLeft        |windowborderleft|
  29. V- WindowBorderRight    |windowborderright|
  30. V- WindowBorderTop        |windowbordertop|
  31. V- WindowColors            |windowcolors|
  32. V- WindowHeight            |windowheight|
  33. V- WindowName            |windowname|
  34. V- WindowTitle            |windowtitle|
  35. C- WindowTo                |windowto|
  36. V- WindowWidth            |windowwidth|
  37. V- WindowX                |windowx|
  38. V- WindowY                |windowy|
  39. V- WorkbenchColors        |workbenchcolors|
  40. V- WorkbenchHeight        |workbenchheight|
  41. V- WorkbenchWidth        |workbenchwidth|
  42. [E]
  43.  
  44. |getviewoffset|
  45. WT GetViewOffset <XVarName>, <YVarName>
  46. PL Returns the view offset.  This is commonly
  47. PT used with 
  48. BS SetViewOffset
  49. PL  to find out the
  50. PL views current offset so that an calculated
  51. PL move can be made or to store off the
  52. PL original offset.
  53. ED
  54.  
  55. |getwindowlimits|
  56. WT GetWindowLimits <MinWidthVarName>, <MinHeightVarName>, <MaxWidthVarName>, <MaxHeightVarName>
  57. PL Returns the current window sizing limits
  58. PL into the specified variables.
  59. PL
  60. PT SEE ALSO: 
  61. BS SetWindowLimits
  62. PT .
  63. ED
  64.  
  65. |hires|
  66. WT {Logical}=HiRes
  67. PT This returns 
  68. BS True
  69. PL  when the current card's
  70. PL screen is in High-Resolution mode.  High-
  71. PL resolution mode used 60ns pixels and 
  72. PL normally has 640 pixels horizontally.
  73. PL
  74. PT SEE ALSO: 
  75. BS Interlace
  76. PT .
  77. ED
  78.  
  79. |interlace|
  80. WT {Logical}=Interlace
  81. PT This returns 
  82. BS True
  83. PL  when the current card's
  84. PL screen is in Interlace mode.  Interlace
  85. PL mode causes normal displays to flicker and
  86. PL normally has 400/512 pixels vertically.
  87. PL
  88. PT SEE ALSO: 
  89. BS HiRes
  90. PT .
  91. ED
  92.  
  93. |mousex|
  94. WT {Integer}=MouseX
  95. PL This returns the mouse's X coordinate
  96. PL when this event was caused.  If no event
  97. PL script is running then this returns the last
  98. PL known X position of the mouse.
  99. PL
  100. PT SEE ALSO: 
  101. BS MouseY
  102. PT .
  103. ED
  104.  
  105. |mousey|
  106. WT {Integer}=MouseY
  107. PL This returns the mouse's Y coordinate
  108. PL when this event was caused.  If no event
  109. PL script is running then this returns the last
  110. PL known Y position of the mouse.
  111. PL
  112. PT SEE ALSO: 
  113. BS MouseX
  114. PT .
  115. ED
  116.  
  117. |movescreen|
  118. WT MoveScreen {DeltaX}, {DeltaY}
  119. PL Move the screen a specified number of pixels
  120. PL right/left {DeltaX}, or up/down {DeltaY}.
  121. PL Note: Under AmigaDOS 1.3, right/left and
  122. PL up doesn't work all that well.
  123. PL
  124. PT SEE ALSO: 
  125. BS ScreenX
  126. PT  and 
  127. BS ScreenY
  128. PT .
  129. ED
  130.  
  131. |movewindow|
  132. WT MoveWindow {DeltaX}, {DeltaY}
  133. PL Move the window a specified number of pixels
  134. PL right/left {DeltaX}, or up/down {DeltaY}.
  135. PL
  136. PT SEE ALSO: 
  137. BS WindowX
  138. PT  and 
  139. BS WindowY
  140. PT .
  141. ED
  142.  
  143. |ntsc|
  144. WT {Logical}=NTSC
  145. PL If the deck is running on a NTSC system
  146. PT this variable will return 
  147. BS True
  148. PL .  When
  149. PL running on a PAL system it will return
  150. PT a 
  151. BS False
  152. PL .
  153. ED
  154.  
  155. |pointer|
  156. WT Pointer {Logical}
  157. PT Turns the mouse pointer 
  158. BS On
  159. PT  or 
  160. BS Off
  161. PT .
  162. PL
  163. PT SEE ALSO: 
  164. BS SetPointer
  165. PT .
  166. ED
  167.  
  168. |resizewindow|
  169. WT ResizeWindow {width}, {height}
  170. PL Resize the window to a new width and height.
  171. PL
  172. PT SEE ALSO: 
  173. BS WindowWidth
  174. PT  and 
  175. BS WindowHeight
  176. PT .
  177. ED
  178.  
  179. |screenaddress|
  180. WT {Integer}=ScreenAddress
  181. PL Returns a integer that is a pointer to the
  182. PL current window's screen.
  183. ED
  184.  
  185. |screencolors|
  186. WT {Integer}=ScreenColors
  187. PL This returns the number of colors available
  188. PL for the current screen.
  189. PL
  190. PT SEE ALSO: 
  191. BS WindowColors
  192. PT .
  193. ED
  194.  
  195. |screenheight|
  196. WT {Integer}=ScreenHeight
  197. PL This returns the height of the current
  198. PL screen.
  199. PL
  200. PT SEE ALSO: 
  201. BS WindowHeight
  202. PT .
  203. ED
  204.  
  205. |screentitle|
  206. WT {String}=ScreenTitle
  207. PL This returns the titlebar text of the
  208. PL current screen.
  209. PL
  210. PT SEE ALSO: 
  211. BS WindowTitle
  212. PT .
  213. ED
  214.  
  215. |screentitlebar|
  216. WT ScreenTitleBar {Logical}
  217. PL If using a custom screen, this command
  218. PL allows the screen's title bar to be
  219. PL displayed if the logical expression is
  220. PT 
  221. BS True
  222. PT , or hidden if it is 
  223. BS False
  224. PL .
  225. PL NOTE: The window's title bar may hide
  226. PL       the screen's title, even if TRUE
  227. ED
  228.  
  229. |screento|
  230. WT ScreenTo <flags>
  231. PL Moves the screen to front or back depending
  232. PL on the flag settings.  See the manual for
  233. PL a full description of this command.
  234. PL 
  235. PT SEE ALSO: 
  236. BS WindowTo
  237. PT .
  238. ED
  239.  
  240. |screenwidth|
  241. WT {Integer}=ScreenWidth
  242. PL This returns the width of the current
  243. PL screen.
  244. PL
  245. PT SEE ALSO: 
  246. BS WindowWidth
  247. PT .
  248. ED
  249.  
  250. |screenx|
  251. WT {Integer}=ScreenX
  252. PL This returns the current screen's X offset
  253. PL from the system's master view.
  254. PL
  255. PT SEE ALSO: 
  256. BS ScreenY
  257. PT .
  258. ED
  259.  
  260. |screeny|
  261. WT {Integer}=ScreenY
  262. PL This returns the current screen's Y offset
  263. PL from the system's master view.
  264. PL
  265. PT SEE ALSO: 
  266. BS ScreenX
  267. PT .
  268. ED
  269.  
  270. |setpointer|
  271. WT SetPointer [{BrushBufferName} [,{XHotSpot}, {YHotSpot}]]
  272. PL Use a DPaint style brush as the mouse
  273. PL pointer.  If given, {XHotSpot} and
  274. PL {YHotSpot} indicate the mouse's "hotspot".
  275. PL If no parameters are given, we will use the
  276. PL system pointer.
  277. PT SEE ALSO: 
  278. BS Pointer
  279. PT  and 
  280. BS SetBusyPointer
  281. PT .
  282. ED
  283.  
  284. |setscreentitle|
  285. WT SetScreenTitle {String}
  286. PL This will change the screen's titlebar
  287. PL text display.
  288. PL
  289. PT SEE ALSO: 
  290. BS ScreenTitle
  291. PT  and 
  292. BS ScreenTitleBar
  293. PT .
  294. ED
  295.  
  296. |setviewoffset|
  297. WT SetViewOffset {X}, {Y}
  298. PL Changes the system's view offset.  Used
  299. PT with 
  300. BS GetViewOffset
  301. PL .  NOTE: Use this
  302. PL with great caution.
  303. ED
  304.  
  305. |setwindowlimits|
  306. WT SetWindowLimits {MinWidth}, {MinHeight}, {MaxWidth}, {MaxHeight}
  307. PL Defines the window's sizing limits to be
  308. PL between {MinWidth} and {MaxWidth}
  309. PL horizontally and between {MinHeight} and
  310. PL {MaxHeight} vertically.
  311. PL
  312. PT SEE ALSO: 
  313. BS GetWindowLimits
  314. PT .
  315. ED
  316.  
  317. |setwindowtitle|
  318. WT SetWindowTitle {String}
  319. PL This will change the window's titlebar
  320. PL text display.
  321. PL
  322. PT SEE ALSO: 
  323. BS WindowTitle
  324. PT .
  325. ED
  326.  
  327. |windowaddress|
  328. WT {Integer}=WindowAddress
  329. PL Returns a integer that is a pointer to the
  330. PL current window.
  331. ED
  332.  
  333. |windowborderbottom|
  334. WT {Integer}=WindowBorderBottom
  335. PL This returns the height of the bottom
  336. PL window border.  This is affected by the
  337. PL border flag in window options.
  338. PL
  339. PT SEE ALSO: 
  340. BS WindowBorderTop
  341. PT , 
  342. BS WindowBorderLeft
  343. PL
  344. PT           and 
  345. BS WindowBorderRight
  346. PT .
  347. ED
  348.  
  349. |windowborderleft|
  350. WT {Integer}=WindowBorderLeft
  351. PL This returns the width of the left
  352. PL window border.  This is affected by the
  353. PL border flag in window options.
  354. PL
  355. PT SEE ALSO: 
  356. BS WindowBorderTop
  357. PL , 
  358. PT   
  359. BS WindowBorderBottom
  360. PT  and 
  361. BS WindowBorderRight
  362. PT .
  363. ED
  364.  
  365. |windowborderright|
  366. WT {Integer}=WindowBorderRight
  367. PL This returns the width of the right
  368. PL window border.  This is affected by the
  369. PL border flag in window options.
  370. PL
  371. PT SEE ALSO: 
  372. BS WindowBorderTop
  373. PT , 
  374. BS WindowBorderLeft
  375. PL
  376. PT           and 
  377. BS WindowBorderBottom
  378. PT .
  379. ED
  380.  
  381. |windowbordertop|
  382. WT {Integer}=WindowBorderTop
  383. PL This returns the height of the top
  384. PL window border.  This is affected by the
  385. PL border flag in window options and the
  386. PL font size of the current screen.
  387. PT SEE ALSO: 
  388. BS WindowBorderBottom
  389. PL , 
  390. PT     
  391. BS WindowBorderLeft
  392. PT  and 
  393. BS WindowBorderRight
  394. PT .
  395. ED
  396.  
  397. |windowcolors|
  398. WT {Integer}=WindowColors
  399. PL This returns the number of colors available
  400. PL for the current window.
  401. PL
  402. PT SEE ALSO: 
  403. BS ScreenColors
  404. PT .
  405. ED
  406.  
  407. |windowheight|
  408. WT {Integer}=WindowHeight
  409. PL This returns the height of the current
  410. PL window.
  411. PL
  412. PT SEE ALSO: 
  413. BS ScreenHeight
  414. PT .
  415. ED
  416.  
  417. |windowname|
  418. WT {String}=WindowName
  419. PL This returns the object name of the current
  420. PL window.  Under normal cases this will
  421. PL always be "UserWindow"
  422. ED
  423.  
  424. |windowtitle|
  425. WT {String}=WindowTitle
  426. PL This returns the titlebar text of the
  427. PL current window.
  428. PL
  429. PT SEE ALSO: 
  430. BS ScreenTitle
  431. PT .
  432. ED
  433.  
  434. |windowto|
  435. WT WindowTo <flags>
  436. PL Moves the window to front or back depending
  437. PL on the flag settings.  See the manual for
  438. PL a full description of this command.
  439. PL 
  440. PT SEE ALSO: 
  441. BS ScreenTo
  442. PT .
  443. ED
  444.  
  445. |windowwidth|
  446. WT {Integer}=WindowWidth
  447. PL This returns the width of the current
  448. PL window.
  449. PL
  450. PT SEE ALSO: 
  451. BS ScreenWidth
  452. PT .
  453. ED
  454.  
  455. |windowx|
  456. WT {Integer}=WindowX
  457. PL This returns the current window's X offset
  458. PL from its screen origin.
  459. PL
  460. PT SEE ALSO: 
  461. BS WindowY
  462. PT .
  463. ED
  464.  
  465. |windowy|
  466. WT {Integer}=WindowY
  467. PL This returns the current window's Y offset
  468. PL from its screen origin.
  469. PL
  470. PT SEE ALSO: 
  471. BS WindowX
  472. PT .
  473. ED
  474.  
  475. |workbenchcolors|
  476. WT {Integer}=WorkbenchColors
  477. PL This returns the number of colors available
  478. PL on the workbench screen.
  479. PL
  480. PT SEE ALSO: 
  481. BS ScreenColors
  482. PT .
  483. ED
  484.  
  485. |workbenchheight|
  486. WT {Integer}=WorkbenchHeight
  487. PL This returns the height of the workbench
  488. PL screen.
  489. PL
  490. PT SEE ALSO: 
  491. BS ScreenHeight
  492. PT .
  493. ED
  494.  
  495. |workbenchwidth|
  496. WT {Integer}=WorkbenchWidth
  497. PL This returns the width of the workbench
  498. PL screen.
  499. PL
  500. PT SEE ALSO: 
  501. BS ScreenWidth
  502. PT .
  503. ED
  504.  
  505.  
  506.